API Authentication Guide
This guide explains how to authenticate with the UTMStack API using curl, retrieve a Bearer token, and access secured endpoints. It also includes details about where to find the official API documentation for each instance.
Step 1: Authentication Request
Use the /api/authenticate endpoint to log in and receive a Bearer token.
🔧 Request Example:
Make sure to replace the credentials (username and password) with the actual user credentials for your environment.
Step 2: Parse the Response
The response will be a JSON object containing the Bearer token, usually under the key id_token or similar, for example:
Step 3: Use the Bearer Token
Include the token in the Authorization header when making requests to protected endpoints.
Use the /management/logs endpoint to log in and receive a Bearer token.
Request
Response
What happens when you don’t include the Authorization header when making requests to protected endpoints.
Use the /management/logs endpoint to log in and receive a Bearer token.
Request
Response
Official API Documentation
UTMStack provides two official resources where developers can explore and interact with the API:
API Reference on Documentation Portal
You can access the full API reference, including endpoint structure, request/response schemas, and example usage under the API Reference tab
Interactive Swagger UI (Demo Instance)
For hands-on testing and live API interaction, you can explore the Swagger UI provided by the public UTMStack demo instance:
https://demo.utmstack.com/swagger-ui/index.html
Each client instance has its own unique Swagger URL, based on how their environment is configured.
Examples:
https://<your-company>.utmstack.com/swagger-ui/index.html
https://utmstack.<your-domain>.com/swagger-ui/index.html
These tools make it easy to test endpoints, view required parameters, and understand the behavior of the platform’s APIs.